Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a cache for samples #7497

Open
wants to merge 20 commits into
base: master
Choose a base branch
from

Conversation

sakertooth
Copy link
Contributor

@sakertooth sakertooth commented Sep 14, 2024

Adds an in-memory cache for samples. Callers can fetch data from the cache using two overloads: one for audio files, and another for Base64 strings. The cache stores weak pointers to the samples and returns shared pointers to the callers. However, the cache in the future will probably need to store the weak pointers along with sample thumbnails and possibly other kinds of metadata for each sample, which should be fairly easy to do as all that needs to be done is to store a collection of the data we need in a struct/class instead of just the weak pointer to the buffer.

For audio files, we check the last write time for the file to see if it needs updating each time it is fetched, and update it if necessary. For Base64 strings, we just compare the contents.

SampleLoader loads audio data by querying the cache for it, rather than creating them manually. As such, the SampleLoader::create* functions where renamed to SampleLoader::load*.

The memory usage has dropped significantly when using duplicate samples (htop readings went from 28.5% to 3.6% for me with a project that had a number of sample clips, each ~3 minutes long), and projects load faster (There is still some delay because of the waveform drawing, but this should be addressed soon. The speedup is more noticeable when you zoom all the way out before loading a project as a result).

Should supersede #7058 I believe.

Copy link
Member

@messmerd messmerd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gave it a quick look-over.

Also,

  • Sample's move constructor and move assignment operator should be marked noexcept
  • Sample::s_interpolationMargins should be renamed to Sample::InterpolationMargins since it is public
  • sample_rate_t could be used instead of int for the sample rate (See this commit for what needed to be changed: 10162ec)

include/FileSystemHelpers.h Outdated Show resolved Hide resolved
include/SampleLoader.h Outdated Show resolved Hide resolved
include/SampleDatabase.h Outdated Show resolved Hide resolved
@sakertooth
Copy link
Contributor Author

sakertooth commented Nov 13, 2024

Sample's move constructor and move assignment operator should be marked noexcept
Sample::s_interpolationMargins should be renamed to Sample::InterpolationMargins since it is public
sample_rate_t could be used instead of int for the sample rate (See this commit for what needed to be changed: 10162ec)

Thanks, I will make another PR to address these issues separately. However, about the int -> sample_rate_t change, I never really understood why we have those types when basic types like int will work just as well. We already have to convert the sample rate to an int when processing the project file anyways. I can't really see the benefit using sample_rate_t brings, and it adds more complexity than int does (not in terms how long the type is.. well maybe, but more so having to know what is the actual type is that we are dealing with here on top of adding more code that we don't really need in the codebase).

@sakertooth sakertooth changed the title Add a database for samples Add a cache for samples Nov 13, 2024
@sakertooth
Copy link
Contributor Author

Any updates @messmerd?

include/SampleCache.h Outdated Show resolved Hide resolved
@messmerd
Copy link
Member

This PR looks pretty good to me code-wise. I'll test it next.

include/SampleCache.h Outdated Show resolved Hide resolved
include/SampleCache.h Outdated Show resolved Hide resolved
src/core/SampleCache.cpp Outdated Show resolved Hide resolved
src/core/SampleCache.cpp Outdated Show resolved Hide resolved
sakertooth and others added 2 commits November 21, 2024 12:48
Co-authored-by: Dalton Messmer <[email protected]>
Co-authored-by: Dalton Messmer <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants